/*
 * Copyright (c) "Neo4j"
 * Neo4j Sweden AB [http://neo4j.com]
 *
 * This file is part of Neo4j.
 *
 * Neo4j is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
package org.neo4j.gds.core.utils.mem;

import org.neo4j.gds.core.GraphDimensions;

import java.util.Collection;
import java.util.Collections;

/**
 * A description of an object that has resources residing in memory.
 */
public interface MemoryEstimation {

    /**
     * @return a textual description for this component.
     */
    String description();

    /**
     * @return nested resources of this component.
     */
    default Collection<MemoryEstimation> components() {
        return Collections.emptyList();
    }

    default MemoryEstimation times(long factor) {
        return MemoryEstimations.andThen(this, memoryRange -> memoryRange.times(factor));
    }

    MemoryTree estimate(GraphDimensions dimensions, int concurrency);
}
